
<h1>过滤器</h1>

<p>beego 支持自定义过滤中间件，例如安全验证，强制跳转等。</p>

<p>过滤器函数如下所示：</p>

<pre><code>beego.InsertFilter(pattern string, position int, filter FilterFunc, params ...bool)
</code></pre>

<p>InsertFilter 函数的三个必填参数，一个可选参数</p>

<ul>
    <li>pattern 路由规则，可以根据一定的规则进行路由，如果你全匹配可以用 <code>*</code><br /></li>
    <li>position 执行 Filter 的地方，五个固定参数如下，分别表示不同的执行过程<br />

        <ul>
            <li>BeforeStatic 静态地址之前<br /></li>
            <li>BeforeRouter 寻找路由之前<br /></li>
            <li>BeforeExec 找到路由之后，开始执行相应的 Controller 之前<br /></li>
            <li>AfterExec 执行完 Controller 逻辑之后执行的过滤器<br /></li>
            <li>FinishRouter 执行完逻辑之后执行的过滤器<br /></li>
        </ul></li>
    <li>filter filter 函数 type FilterFunc func(*context.Context)<br /></li>
    <li>params<br />

        <ol>
            <li>设置 returnOnOutput 的值(默认 true), 如果在进行到此过滤之前已经有输出，是否不再继续执行此过滤器,默认设置为如果前面已有输出(参数为true)，则不再执行此过滤器<br /></li>
            <li>是否重置 filters 的参数，默认是 false，因为在 filters 的 pattern 和本身的路由的 pattern 冲突的时候，可以把 filters 的参数重置，这样可以保证在后续的逻辑中获取到正确的参数，例如设置了 <code>/api/*</code> 的 filter，同时又设置了 <code>/api/docs/*</code> 的 router，那么在访问 <code>/api/docs/swagger/abc.js</code> 的时候，在执行 filters 的时候设置 <code>:splat</code> 参数为 <code>docs/swagger/abc.js</code>，但是如果不清楚 filter 的这个路由参数，就会在执行路由逻辑的时候保持 <code>docs/swagger/abc.js</code>，如果设置了 true，就会重置 <code>:splat</code> 参数.<br /></li>
        </ol></li>
</ul>

<blockquote>
    <blockquote>
        <blockquote>
            <p>AddFilter 从beego1.3 版本开始已经废除</p>
        </blockquote>
    </blockquote>
</blockquote>

<p>如下例子所示，验证用户是否已经登录，应用于全部的请求：</p>

<pre lang="go"><code>var FilterUser = func(ctx *context.Context) {
    _, ok := ctx.Input.Session(&quot;uid&quot;).(int)
    if !ok &amp;&amp; ctx.Request.RequestURI != &quot;/login&quot; {
        ctx.Redirect(302, &quot;/login&quot;)
    }
}

beego.InsertFilter(&quot;/*&quot;,beego.BeforeRouter,FilterUser)
</code></pre>

<blockquote>
    <blockquote>
        <blockquote>
            <p>这里需要特别注意使用 session 的 Filter 必须在 BeforeStatic 之后才能获取，因为 session 没有在这之前初始化。</p>
        </blockquote>
    </blockquote>
</blockquote>

<p>还可以通过正则路由进行过滤，如果匹配参数就执行：</p>

<pre lang="go"><code>var FilterUser = func(ctx *context.Context) {
    _, ok := ctx.Input.Session(&quot;uid&quot;).(int)
    if !ok {
        ctx.Redirect(302, &quot;/login&quot;)
    }
}
beego.InsertFilter(&quot;/user/:id([0-9]+)&quot;,beego.BeforeRouter,FilterUser)
</code></pre>

<h2>过滤器实现路由</h2>

<p>beego1.1.2 开始 Context.Input 中增加了 RunController 和 RunMethod, 这样我们就可以在执行路由查找之前,在 filter 中实现自己的路由规则.</p>

<p>如下示例实现了如何实现自己的路由规则:</p>

<pre lang="go"><code>var UrlManager = func(ctx *context.Context) {
    // 数据库读取全部的 url mapping 数据
    urlMapping := model.GetUrlMapping()
    for baseurl,rule:=range urlMapping {
        if baseurl == ctx.Request.RequestURI {
            ctx.Input.RunController = rule.controller
            ctx.Input.RunMethod = rule.method
            break
        }
    }
}

beego.InsertFilter(&quot;/*&quot;,beego.BeforeRouter,UrlManager)
</code></pre>
